﻿<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
  
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>Etl.Net Debugger </title>
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="Etl.Net Debugger ">
    <meta name="generator" content="docfx 2.40.1.0">
    
    <link rel="shortcut icon" href="../favicon.ico">
    <link rel="stylesheet" href="../styles/docfx.vendor.css">
    <link rel="stylesheet" href="../styles/docfx.css">
    <link rel="stylesheet" href="../styles/main.css">
    <meta property="docfx:navrel" content="../toc.html">
    <meta property="docfx:tocrel" content="../toc.html">
    
    
    
  </head>
  <body data-spy="scroll" data-target="#affix" data-offset="120">
    <div id="wrapper">
      <header>
        
        <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
          <div class="container">
            <div class="navbar-header">
              <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
                <span class="sr-only">Toggle navigation</span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
              </button>
              
              <a class="navbar-brand" href="../index.html">
                <img id="logo" class="svg" src="../images/logo.svg" alt="">
              </a>
            </div>
            <div class="collapse navbar-collapse" id="navbar">
              <form class="navbar-form navbar-right" role="search" id="search">
                <div class="form-group">
                  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
                </div>
              </form>
              <a class="navbar-brand" href="https://github.com/paillave/Etl.Net" style="float:right">
                <img id="logo" class="svg" src="../images/github.svg" style="height:52px">
              </a>
            </div>
          </div>
        </nav>
        
        <div class="subnav navbar navbar-default">
          <div class="container hide-when-search" id="breadcrumb">
            <ul class="breadcrumb">
              <li></li>
            </ul>
          </div>
        </div>
      </header>
      <div role="main" class="container body-content hide-when-search">
        <div class="article row grid">
          <div class="col-md-10">
            <article class="content wrap" id="_content" data-uid="">
<h1 id="etlnet-debugger">Etl.Net Debugger</h1>

<p>Tool to debug Etl.Net processes.</p>
<p><a href="https://github.com/paillave/Etl.Net-Debugger/releases">Download</a></p>
<h2 id="features">Features</h2>
<ul>
<li>View the list of process descriptions in an assembly</li>
<li>View the detailed description of a process</li>
<li>Execute a process by providing its input values</li>
<li>View rows issued by each node of the process</li>
<li>View the detail of a row issued by a node of the process</li>
</ul>
<h2 id="how-to-use-etlnet-debugger">How to use Etl.Net Debugger</h2>
<h3 id="open-the-application-electronnethostexe">Open the application <code>electron.net.host.exe</code></h3>
<p>The application takes a little while to open and there is no splash screen at the moment. It shows an empty screen awaiting the user to select a process.</p>
<p><img src="README/Capture1.PNG" alt="Debugger" title="Debugger"></p>
<h3 id="click-on-select-process">Click on <code>SELECT PROCESS</code></h3>
<p>This will show a form for the user to select an assembly and a process.
<img src="README/Capture2.PNG" alt="Debugger" title="Debugger"></p>
<h3 id="drag-and-drop-the-assembly-that-contains-the-process-on-the-dedicated-area">Drag and drop the assembly that contains the process on the dedicated area</h3>
<p>This will show the list of processes contained in the selected assembly.</p>
<div class="NOTE">
<h5>Note</h5>
<p>Processes must be static methods with this signature:</p>
<pre><code class="lang-CSharp">public static void AnyMethodName(ISingleStream&lt;AnyClassType&gt; rootStream)
</code></pre>
</div>
<p><img src="README/Capture3.PNG" alt="Debugger" title="Debugger"></p>
<h3 id="click-on-the-process-that-must-be-executed-or-verified">Click on the process that must be executed or verified</h3>
<p>This will show the detailed structure of the selected process.
<img src="README/Capture4.PNG" alt="Debugger" title="Debugger"></p>
<h3 id="click-on-run-the-play-icon-at-the-right-of-select-process">Click on <code>RUN</code> (the play icon at the right of <code>SELECT PROCESS</code>)</h3>
<p>This will show a form were values of properties of the input config type can be given.</p>
<div class="NOTE">
<h5>Note</h5>
<p>Type that are not natively serializable in .net will cause a failure for execution. To run such a process, create a dedicated process that wraps this process.</p>
</div>
<p><img src="README/Capture5.PNG" alt="Debugger" title="Debugger"></p>
<h3 id="click-on-execute">Click on <code>EXECUTE</code></h3>
<p>This will run the process by providing real time evolution of the process. The quantity of rows issued by each node will impact the thickness of the matching stream representation.</p>
<div class="NOTE">
<h5>Note</h5>
<p>Errors in the process execution are not properly handled yet in this version.</p>
</div>
<p><img src="README/Capture6.PNG" alt="Debugger" title="Debugger"></p>
<h3 id="click-on-a-node">Click on a node</h3>
<p>This will show the list of events issued by this node, including issued rows.</p>
<p><img src="README/Capture7.PNG" alt="Debugger" title="Debugger"></p>
<h3 id="click-on-a-row">Click on a row</h3>
<p>This will show the detail of the trace (including the content of the issued row).</p>
<p><img src="README/Capture8.PNG" alt="Debugger" title="Debugger"></p>
</article>
          </div>
          
          <div class="hidden-sm col-md-2" role="complementary">
            <div class="sideaffix">
              <p><img src="../images/full-black-logo.svg" alt="Logo Etl.Net"></p>
              <div class="contribution">
                <ul class="nav">
                  <li>
                    <a href="https://github.com/paillave/Etl.Net/blob/develop/docfx_project/debugger/index.md/#L1" class="contribution-link">Improve this Doc</a>
                  </li>
                </ul>
              </div>
              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
              <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
              </nav>
            </div>
          </div>
        </div>
      </div>
      
      <footer>
        <div class="grad-bottom"></div>
        <div class="footer">
          <div class="container">
            <span class="pull-right">
              <a href="#top">Back to top</a>
            </span>
            
            <span>Generated by <strong>DocFX</strong></span>
          </div>
        </div>
      </footer>
    </div>
    
    <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
    <script type="text/javascript" src="../styles/docfx.js"></script>
    <script type="text/javascript" src="../styles/main.js"></script>
  </body>
</html>
